Feature/ASAA-23 Compose UI x Karumi Shot Testing #85

Br-DiorD · 2022-08-17T18:47:21Z

Initial implementation of the Karumi Screenshot testing package with Compose UI testing combined.

Code uses Compose UI tests to collect the screenshots and karumi to save and compare them

Please see the Screenshot Testing: Compose UI x Karumi Confluence page created

…oid-ArchitectureDemo into feature/karumui_shots

…oid-ArchitectureDemo into feature/ASAA-23-karumi

BottleRocket-Colin

Is it possible to adjust font size so screen shots look reasonable?

app/src/main/AndroidManifest.xml

Br-DiorD · 2022-08-17T20:02:02Z

@BottleRocket-Colin so the font size is still a pending questions for me. The tests are suppose to run as and we shouldn't have to add that but I will continue to look into solution.

BottleRocket-Colin · 2022-08-18T19:45:43Z

app/src/androidTest/java/com/bottlerocketstudios/brarchitecture/HomeScreenUITest.kt

+        compareScreenshot(composeRule.onRoot())
+    }
+
+    fun renderComponent(state: HomeScreenState? = null) {


@Br-DiorD Think I figured out our issue. We should wrap HomeScreen like this:

ArchitectureDemoTheme {
HomeScreen(state)
}

Also, Could HomeScreenState in function signature be non null?

@BottleRocket-Colin nice! I'll give it a shot after this meeting. I do wonder why it is only an issue on certain screenshots because the Pull RequestScreenshot shot is fine.

@Br-DiorD _ would say that the PR request screenshot is probably not correct but just closer to being correct. It's a matter of where our h4 and h5 typographies are closer to the default sizes but our h1 is very small compared to the h1 default. So some screens will show closer to correct than others depending on which typography elements are being used.

@BottleRocket-Colin fixed. Sorry for the delay :)

jaredstockton · 2022-08-18T21:56:44Z

@Br-DiorD I'll take a look at this tomorrow and provide some feedback!

jaredstockton

Note that I'm currently unable to execute the tests OR record new screenshots for my API 31 Pixel 4 emulator. I'm going to continue to look into this.

@Br-DiorD It would be awesome if there was some way to dictate the emulator configuration to be used to run the tests so any dev would be able to run the tests on their machine and get the same results. If there isn't a programmatic way to do that, even just listing the emulator configuration in the README.md would be helpful

buildSrc/src/main/kotlin/Dependencies.kt

compose/build.gradle.kts

buildSrc/src/main/kotlin/Dependencies.kt

app/src/androidTest/java/com/bottlerocketstudios/brarchitecture/HomeScreenUITest.kt

app/src/androidTest/java/com/bottlerocketstudios/brarchitecture/PullRequestScreenshotTest.kt

app/src/androidTest/java/com/bottlerocketstudios/brarchitecture/HomeScreenUITest.kt

jaredstockton · 2022-08-19T21:53:27Z

Note that I'm currently unable to execute the tests OR record new screenshots for my API 31 Pixel 4 emulator. I'm going to continue to look into this.

tldr; Turns out I needed to uninstall a previously installed Architecture Demo build before attempting to run the integration tests.

Findings:
The Android Studio logs mentioned this error: Unknown platform error occurred when running the UTP test suite. Please check logs for details.
Not too helpful but there was also a reference to a pb file (app/build/outputs/androidTest-results/connected/flavors/internal/test-result.pb). I opened it in a text editor (Visual Studio Code, specifically) and saw that the root cause of the failure mentioned within:

Message: Failed to install APKs: INSTALL_FAILED_SHARED_USER_INCOMPATIBLE

…d add a shot html report launch script.

…oid-ArchitectureDemo into feature/ASAA-23-karumi � Conflicts: � app/src/main/java/com/bottlerocketstudios/brarchitecture/ui/repository/RepositoryCommitViewModel.kt

Br-DiorD · 2022-09-09T17:49:27Z

@br-jared-stockton Got to remind myself to add this to the confluence but yes you have to uninstall previous app version IOT get the test to run because the addition of the sharedUserId in the Manifest requires a complete reboot to implement itself i guess.

…an ups

jaredstockton · 2022-09-09T19:33:44Z

@Br-DiorD It would be awesome if there was some way to dictate the emulator configuration to be used to run the tests so any dev would be able to run the tests on their machine and get the same results. If there isn't a programmatic way to do that, even just listing the emulator configuration in the README.md would be helpful

@Br-DiorD This is the last thing I'd like to see done for this PR, primarily so that devs/CI can setup an emulator to get consistent results (meaning any team member could setup their emulator with some given configuration and run the snapshot tests successfully). I imagine that the emulator would match the emulator used to check in the screenshots :)

Br-DiorD · 2022-09-09T19:35:01Z

@br-jared-stockton on it. I don't remember having to do anything on the emulator for it to work so I'm going to create a new 1 and start from scratch to see what happens 👍

…oid-ArchitectureDemo into feature/ASAA-23-karumi � Conflicts: � buildSrc/src/main/kotlin/Dependencies.kt

Br-DiorD · 2022-09-26T14:58:27Z

@br-jared-stockton updated with link to Confluence where I added Emulator setup steps. Link can be found in both the Base test file and the README.md file.

…e the correct theme

jaredstockton · 2022-10-03T20:27:55Z

updated with link to Confluence where I added Emulator setup steps. Link can be found in both the Base test file and the README.md file.

@Br-DiorD I was thinking of something more along the lines of the scripts that are in the shot-consumer folder of the shot dependency: https://github.com/pedrovgs/Shot/tree/master/shot-consumer/scripts

The idea is that a new developer would be able to execute create_emulator.sh and start_emulator.sh and validate all screenshots OR add new screenshot tests that match the screenshots already present (effectively the same emulator with same OS + screen width + screen height + pixel density)

You could copy/paste those initial scripts into the architecture demo project and then tweak to suite (if you want to use api 31 and different screen width/height values, etc).

Then you'd need to retake all screenshots with the emulator created from the script.

Once all of that is done, then anybody would be able to run the screenshot tests and take new ones that match the existing emulator criteria without having to manually create/configure a new emulator on their machine :D

jaredstockton

See previous comment

Br-DiorD added 7 commits August 10, 2022 14:39

implementation commit

d0ffe7f

stable commit 1

ebedef0

fix test failure due to duplicate screenshots

c880b92

move file location

80a2baf

Merge branch 'develop' of https://github.com/BottleRocketStudios/Andr…

21fe073

…oid-ArchitectureDemo into feature/karumui_shots

Add todo

95e6c87

Merge branch 'develop' of https://github.com/BottleRocketStudios/Andr…

9f51a4d

…oid-ArchitectureDemo into feature/ASAA-23-karumi

BottleRocket-Colin requested review from BottleRocket-Colin and jaredstockton August 17, 2022 18:59

BottleRocket-Colin reviewed Aug 17, 2022

View reviewed changes

app/src/main/AndroidManifest.xml Outdated Show resolved Hide resolved

Add PR screenshot tests

cc70154

BottleRocket-Colin suggested changes Aug 18, 2022

View reviewed changes

jaredstockton suggested changes Aug 19, 2022

View reviewed changes

jaredstockton and others added 2 commits August 19, 2022 17:37

AASA-23 build: Update shot version, add shared Run Configurations, an…

26e3ca3

…d add a shot html report launch script.

Merge branch 'develop' of https://github.com/BottleRocketStudios/Andr…

7ac21f3

…oid-ArchitectureDemo into feature/ASAA-23-karumi � Conflicts: � app/src/main/java/com/bottlerocketstudios/brarchitecture/ui/repository/RepositoryCommitViewModel.kt

delete extra executeScreenshotTest mod(use interal instead) / nit cle…

64be96c

…an ups

Br-DiorD requested review from BottleRocket-Colin and jaredstockton September 9, 2022 17:52

Br-DiorD added 3 commits September 26, 2022 09:26

Merge branch 'develop' of https://github.com/BottleRocketStudios/Andr…

2882dbd

…oid-ArchitectureDemo into feature/ASAA-23-karumi � Conflicts: � buildSrc/src/main/kotlin/Dependencies.kt

test on other devices/error search/add Base file with Confluence Link

d0c8a71

update README.md

0a8e184

wrap renderComponent() in ArchitectureDemoTheme {} so screenshots hav…

1e9aadb

…e the correct theme

jaredstockton suggested changes Oct 3, 2022

View reviewed changes

Feature/ASAA-23 Compose UI x Karumi Shot Testing #85

Are you sure you want to change the base?

Feature/ASAA-23 Compose UI x Karumi Shot Testing #85

Uh oh!

Conversation

Br-DiorD commented Aug 17, 2022

Uh oh!

BottleRocket-Colin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Br-DiorD commented Aug 17, 2022

Uh oh!

BottleRocket-Colin Aug 18, 2022

Choose a reason for hiding this comment

Uh oh!

Br-DiorD Aug 18, 2022

Choose a reason for hiding this comment

Uh oh!

BottleRocket-Colin Aug 22, 2022

Choose a reason for hiding this comment

Uh oh!

Br-DiorD Sep 26, 2022

Choose a reason for hiding this comment

Uh oh!

jaredstockton commented Aug 18, 2022

Uh oh!

jaredstockton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaredstockton commented Aug 19, 2022

Uh oh!

Br-DiorD commented Sep 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jaredstockton commented Sep 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Br-DiorD commented Sep 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Br-DiorD commented Sep 26, 2022

Uh oh!

jaredstockton commented Oct 3, 2022

Uh oh!

jaredstockton left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Br-DiorD commented Sep 9, 2022 •

edited

Loading

jaredstockton commented Sep 9, 2022 •

edited

Loading

Br-DiorD commented Sep 9, 2022 •

edited

Loading